Class FlowMonitorImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.FlowMonitorImpl
All Implemented Interfaces:
IPCObject, FlowMonitor

public class FlowMonitorImpl extends IPCObjectImpl implements FlowMonitor
Information provided by the PKI file:

    \class FlowMonitor
    
    \brief FlowMonitor holds and manipulates the flow monitor.
    
    \example network().getDevice("Router0").getNetflowMonitorManager().getMonitorAt(0)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getMonitorName

      public String getMonitorName()
      Information provided by the PKI file:
      
          \brief Returns the name of the flow monitor.
          
          \return string, the name of the flow monitor.
          
              
      Specified by:
      getMonitorName in interface FlowMonitor
      Returns:
      String Returns a String
    • getRecord

      public FlowRecord getRecord()
      Information provided by the PKI file:
      
          \brief Returns the flow record.
          
          \return FlowRecord, the FlowRecord object.
          
              
      Specified by:
      getRecord in interface FlowMonitor
      Returns:
      FlowRecord Returns a FlowRecord
    • unsetRecord

      public void unsetRecord()
      Information provided by the PKI file:
      
          \brief Unsets the flow record.
          
              
      Specified by:
      unsetRecord in interface FlowMonitor
    • getInterfaceInput

      public FlowMonitorData getInterfaceInput(String interfaceName, boolean isIpv6)
      Information provided by the PKI file:
      
          \brief Returns the input flow monitor data on the specified interface.
          
          \param interfaceName,       interfaceName can be one of the following plus an interface number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param isIpv6, true if IPv6, false if IPv4.
          
          \return FlowMonitorData, the FlowMonitorData object.
          
              
      Specified by:
      getInterfaceInput in interface FlowMonitor
      Parameters:
      interfaceName - Takes in a parameter of interfaceName
      isIpv6 - Takes in a parameter of isIpv6
      Returns:
      FlowMonitorData Returns a FlowMonitorData
    • getInterfaceOutput

      public FlowMonitorData getInterfaceOutput(String interfaceName, boolean isIpv6)
      Information provided by the PKI file:
      
          \brief Returns the output flow monitor data on the specified interface.
          
          \param interfaceName,       interfaceName can be one of the following plus an interface number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param isIpv6, true if IPv6, false if IPv4.
          
          \return FlowMonitorData, the FlowMonitorData object.
          
              
      Specified by:
      getInterfaceOutput in interface FlowMonitor
      Parameters:
      interfaceName - Takes in a parameter of interfaceName
      isIpv6 - Takes in a parameter of isIpv6
      Returns:
      FlowMonitorData Returns a FlowMonitorData
    • getActiveFlowCount

      public int getActiveFlowCount()
      Information provided by the PKI file:
      
          \brief Returns the number of active flows.
          
          \return int, the number of active flows.
          
              
      Specified by:
      getActiveFlowCount in interface FlowMonitor
      Returns:
      int Returns a int
    • getTotalFlowAdded

      public int getTotalFlowAdded()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows.
          
          \return int, the total number of flows.
          
              
      Specified by:
      getTotalFlowAdded in interface FlowMonitor
      Returns:
      int Returns a int
    • getMonitorDataCount

      public int getMonitorDataCount()
      Information provided by the PKI file:
      
          \brief Returns the number of flow monitor data.
          
          \return int, the number of flow monitor data.
          
              
      Specified by:
      getMonitorDataCount in interface FlowMonitor
      Returns:
      int Returns a int
    • getMonitorDataAt

      public FlowMonitorData getMonitorDataAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the flow monitor data at the specified index.
          
          \param index, the index of the flow monitor data of interest.
          
          \return FlowMonitorData, the FlowMonitorData object at the specified index.
          
              
      Specified by:
      getMonitorDataAt in interface FlowMonitor
      Parameters:
      index - Takes in a parameter of index
      Returns:
      FlowMonitorData Returns a FlowMonitorData
    • getExporterCount

      public int getExporterCount()
      Information provided by the PKI file:
      
          \brief Returns the number of NetFlow exporters.
          
          \return int, the number of NetFlow exporters.
          
              
      Specified by:
      getExporterCount in interface FlowMonitor
      Returns:
      int Returns a int
    • getExporterAt

      public NFExporter getExporterAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the NetFlow exporter at the specified index.
          
          \param index, the index of the NetFlow exporter of interest.
          
          \return NFExporter, the NFExporter object at the specified index.
          
              
      Specified by:
      getExporterAt in interface FlowMonitor
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NFExporter Returns a NFExporter
    • toString

      public String toString()
      Information provided by the PKI file:
      
          \brief Returns the flow record output.
          
          \return string, the flow record output.
          
              
      Specified by:
      toString in interface FlowMonitor
      Overrides:
      toString in class Object
      Returns:
      String Returns a String
    • monitorInUse

      public boolean monitorInUse()
      Information provided by the PKI file:
      
          \brief Returns true if the flow monitor is in use, otherwise false.
          
          \return bool, true if the flow monitor is in use, otherwise false.
          
              
      Specified by:
      monitorInUse in interface FlowMonitor
      Returns:
      boolean Returns a boolean
    • getCurrentEntryCount

      public int getCurrentEntryCount()
      Information provided by the PKI file:
      
          \brief Returns the number of flows.
          
          \return int, the number of flows.
          
              
      Specified by:
      getCurrentEntryCount in interface FlowMonitor
      Returns:
      int Returns a int
    • getHighWaterMark

      public int getHighWaterMark()
      Information provided by the PKI file:
      
          \brief Returns the high watermark value.
          
          \return int, the high watermark value.
          
              
      Specified by:
      getHighWaterMark in interface FlowMonitor
      Returns:
      int Returns a int
    • getFlowsAddedCount

      public int getFlowsAddedCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows.
          
          \return int, the total number of flows.
          
              
      Specified by:
      getFlowsAddedCount in interface FlowMonitor
      Returns:
      int Returns a int
    • getFlowsAgedCount

      public int getFlowsAgedCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of expired flows.
          
          \return int, the total number of expired flows.
          
              
      Specified by:
      getFlowsAgedCount in interface FlowMonitor
      Returns:
      int Returns a int
    • getActiveTimeoutCount

      public int getActiveTimeoutCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows that were closed due to long activity.
          
          \return int, the total number of flows that were closed due to long activity.
          
              
      Specified by:
      getActiveTimeoutCount in interface FlowMonitor
      Returns:
      int Returns a int
    • getInactiveTimeoutCount

      public int getInactiveTimeoutCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of flows that were closed due to inactivity.
          
          \return int, the total number of flows that were closed due to inactivity.
          
              
      Specified by:
      getInactiveTimeoutCount in interface FlowMonitor
      Returns:
      int Returns a int
    • getCacheDatabase

      public CacheFlowDatabase getCacheDatabase()
      Information provided by the PKI file:
      
          \brief Returns cache flow database.
          
          \return CacheFlowDatabase, the CacheFlowDatabase object.
          
              
      Specified by:
      getCacheDatabase in interface FlowMonitor
      Returns:
      CacheFlowDatabase Returns a CacheFlowDatabase